Skip to content

fix: API Audit for missing XML documentation [MTT-3881]#2026

Merged
0xFA11 merged 61 commits intodevelopfrom
audit/api-missing-xml-documentation
Jun 27, 2022
Merged

fix: API Audit for missing XML documentation [MTT-3881]#2026
0xFA11 merged 61 commits intodevelopfrom
audit/api-missing-xml-documentation

Conversation

@NoelStephensUnity
Copy link
Copy Markdown
Member

@NoelStephensUnity NoelStephensUnity commented Jun 21, 2022

This PR includes all of the missing XML Documentation as outlined in the spreadsheet.

MTT-3881

Testing and Documentation

  • No tests have been added.
  • Includes documentation for previously-undocumented public API entry points.
  • Includes edits to existing public API documentation.

NoelStephensUnity and others added 16 commits June 21, 2022 14:42
Fixing load and unload XML Documentation issue.
Adding XML Documentation to NetworkManager's ShutdownInProgress property
Adding XML Documentation for NetworkManager's SceneManager property.
Adding XML Documentation to the PrefabHandler property.
Fixed the missing return type XML Documentation issue.
Fixing missing xml documentation for the missing parameter "parentNetworkObject" and adding xml documentation header to OnDestroy.
Adding the XML Documentation for the return value
Adding missing XML documentation to the CheckForNetworkObject method.
This update adds xml documentation to each enum value of NetworkUpdateState
This fix adds the missing XML Documentation parameters
Added return value xml documentation for GetClientOwnedObjects
Added parameter xml documentation for GetPlayerNetworkObject
Adding the missing xml documentation.
Added the missing xml documentation headers
Fixed missing xml documentation issues for:
RotAngleThresholdDefault
ScaleThresholdDefault
PositionThreshold
RotAngleThreshold
ScaleThreshold
Interpolate
OnIsServerAuthoritatitive()
Adding xml documentation for:
InitialMaxPacketQueueSize
InitialMaxPayloadSize
InitialMaxSendQueueSize
s_DriverConstructor
DriverConstructor
ConnectionData
DebugSimulator
@NoelStephensUnity NoelStephensUnity changed the title fix: API Audit for missing XML documentation fix: API Audit for missing XML documentation [MTT-3881] Jun 21, 2022
Adding the last missing XML API documentation for all things "NetworkTransform".
adding missing xml API documentation
adding and updating xml documentation for NetworkVariable and NetowrkVariableBase
Adding XML Documentation to UserNetworkVariableSerialization
Fixing a missing <summary> tag.
updating and adding xml documentation for NetworkList
adding the missing xml documentation for BufferSerializer.
Updating and adding xml documentation for ByteUnpacker and FastBufferReader
Adding cross reference to ByteUnpacker
Adding and updating documentation for FastBufferReader and FastBufferWriter
adding missing type `T` param XML Documentation to IReaderWriter
adding missing xml documentation for ForceNEtworkSerializeByMemcpy
Adding missing xml documentation for NetworkBehaviourReference and NetworkObjectReference
finishing up the missing xml documentation.
missed a few in BufferSerializer and IReaderWriter
Adding xml documentation for the NGO custom editors.
@ashwinimurt
Copy link
Copy Markdown
Contributor

All flagged docs APIs have been fixed. Only TestHelper stuff remains which is not critical for 1.0

@ashwinimurt ashwinimurt marked this pull request as ready for review June 27, 2022 20:47
@ashwinimurt ashwinimurt requested review from a team as code owners June 27, 2022 20:47
@ashwinimurt ashwinimurt enabled auto-merge (squash) June 27, 2022 20:48
@0xFA11 0xFA11 disabled auto-merge June 27, 2022 20:49
@0xFA11 0xFA11 merged commit 9aff85f into develop Jun 27, 2022
@0xFA11 0xFA11 deleted the audit/api-missing-xml-documentation branch June 27, 2022 20:50
/// Note:
/// When this method returns false it could mean:
/// - You are trying to start a client that is already started
/// - It failed during the initial port binding when attempting to begin to connect
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can drop the "when attempting to connect" since this is not a client.

Copy link
Copy Markdown
Contributor

@simon-lemay-unity simon-lemay-unity left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Only reviewed transport changes, but looks good to me!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants